fix(docs): wrap first-column params to avoid table h-scroll#418
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated markdown table styling so first-column cells can wrap across multiple lines instead of forcing horizontal expansion. ChangesMarkdown table wrapping
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
queue.publish()parameter table on the Pub/Sub API reference page (and any table whose first column lists several parameters, e.g.priority/max_retries/timeout/expires/result_ttl) forced a horizontal scrollbar. The first column waswhite-space: nowrap, so a multi-token cell stayed on one line and widened the whole table past the content area, squeezing the description column off-screen.Fix
Relax the first column to
white-space: normal; overflow-wrap: normal. Individual identifiers still stay whole — the existing.md-table td code { white-space: nowrap }rule keeps each code token unbroken — so the cell now folds at the/separators instead of overflowing. Single-token first cells (idempotency_key,notes, …) are unaffected.Result: the content wraps and the table fits its container. No horizontal scroll.
Verification
pnpm --dir docs lint— passpnpm --dir docs types:check— pass (pre-commit)pnpm --dir docs build— static export succeeds; compiled bundle carries the new ruleSummary by CodeRabbit